becu-interop-platform-api

1.0.x
(0 reviews)

Deprecate and Undeprecate Asset

Description

This page consists of the information regarding the operations performed to Deprecate an asset from Exchange, runtime manager and Api manager.

Endpoints

  • Deprecate /assets/deprecate/{assetId}/{apiVersion}
  • UnDeprecate /assets/undeprecate/{assetId}/{apiVersion}

API Design Deprecate Endpoint Sequence Diagram

BECU Interop Platform API orchestrates API calls to the internal-Anypoint exchange APIs and Mulesoft Platform APIs to to deprecate assets.

resources/image-7cf94990-a904-42cf-9da6-773502716b33.png

Deprecate Asset

BECU Interop Platform API enables users to deprecate assets.

Deprecate Asset is under the PATCH /assets/deprecate/{assetId}/{apiVersion} endpoint, and a required assetId, apiVersion must be passed as a uri Param.

Deprecating an asset in Exchange only

  • Request the PATCH /assets/deprecate/{assetId}/{apiVersion} with a deprecateAll header as false
  • BECU Interop Platform deprecates the asset from Exchange.

Deprecating an asset in Exchange, Runtime, API manager

  • Request the PATCH /assets/deprecate/{assetId}/{apiVersion} with a deprecateAll header as true
  • BECU Interop Platform deprecates the asset in Exchange and API manager and Stops the application in runtime manager

API Design UnDeprecate Endpoint Sequence Diagram

BECU Interop Platform API orchestrates API calls to the internal-Anypoint exchange APIs and Mulesoft Platform APIs to to Undeprecate assets.

resources/image-436c0177-7f5f-44bb-966e-e0cb4730f625.png

UnDeprecate Asset

BECU Interop Platform API enables users to deprecate assets.

UnDeprecate Asset is under the PATCH /assets/undeprecate/{assetId}/{apiVersion} endpoint, and a required assetId, apiVersion must be passed as a uri Param.

Below is a list of undeprecating use cases:

UnDeprecating an asset

  • Request the PATCH /assets/undeprecate/{assetId}/{apiVersion}
  • BECU Interop Platform undeprecates the asset in Exchange, API manager and in Runtime Manager

Restrictions

  • Connectors & Common API Dependency

The BECU Interop Platform API, is consuming multiple connectors and Anypoint Platform REST APIs.

Below are the list of connectors which this API is consuming:

  • HTTP Connector
  • Transform Message
  • JSON Logger

Downstream Dependencies

Anypoint Platform REST APIs

Anypoint Platform Login API

Anypoint Cloudhub API for

  • Deprecate asset
  • UnDeprecate asset

Reviews